Skip to content

AI agent instruction updates#13335

Open
bneradt wants to merge 1 commit into
apache:masterfrom
bneradt:agent-instruction-updates
Open

AI agent instruction updates#13335
bneradt wants to merge 1 commit into
apache:masterfrom
bneradt:agent-instruction-updates

Conversation

@bneradt

@bneradt bneradt commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

A few tweaks for guiding AI agents.


Undraft this after @moonchen 's similar updates land and this is merged with those changes:
#13306

@bneradt bneradt added this to the 11.0.0 milestone Jun 25, 2026
@bneradt bneradt self-assigned this Jun 25, 2026
Copilot AI review requested due to automatic review settings June 25, 2026 16:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@bneradt bneradt marked this pull request as draft June 25, 2026 16:55
- Functions/variables: `snake_case``handle_request()`, `server_port`, `cache_key`
- Constants/macros: `UPPER_CASE``HTTP_STATUS_OK`, `MAX_BUFFER_SIZE`
- Member variables: `snake_case` with no prefix → `connection_count`, `buffer_size`
- Private member variables: `snake_case` with `m_` prefix → `m_was_modified`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a quick check and it looks like the leading underscore _foo style is the most common in the existing code. About 71% of private member variables. Could we keep using that?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is sadly common, but generally not advised because of possible conflicts with other internal variables. m_ is the typical pattern, and is also not uncommon in our codebase. We're really better off with m_ prefixes for new variables.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, I was following _ prefix rule because it's written in here to do so.
https://cwiki.apache.org/confluence/display/TS/Coding+Style#CodingStyle-MemberVariables

Probably, it's time to discuss this bike-shedding :)

A few tweaks for guiding AI agents.
@bneradt bneradt force-pushed the agent-instruction-updates branch from 7828aaf to 11fbce8 Compare June 25, 2026 17:30
@bneradt bneradt marked this pull request as ready for review June 25, 2026 17:30
Copilot AI review requested due to automatic review settings June 25, 2026 17:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants